home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / sf33_2.zip / MKSFFBBS.ZIP / MKSFFBBS.DOC < prev    next >
Text File  |  1992-12-14  |  11KB  |  239 lines
  1.                        MKSFFBBS (Make SFFILES.BBS)
  2.                              Version 2.2
  3.                          Written by Mike Woltz
  4.                          Buffalo Creek Software  
  5.                            913 - 39th Street
  6.                       West Des Moines, Iowa 50265
  7.                            All Rights Reserved
  8.  
  9.  
  10. PURPOSE OF MKSFFBBS
  11. -------------------
  12.                          
  13.          MKSFFBBS (Make SFFILES.BBS) is a program developed to
  14.     facilitate sysops in the creation of their SFFILES.BBS/SFFILES.<x>
  15.     (hereinafter referred to as SFFILES.BBS) which is used when
  16.     running SPITFIRE Bulletin Board System.  SFFILES.BBS is used to
  17.     provide a file listing of a bulletin board's individual File Areas.
  18.     SFFILES.BBS is displayed to the user to show what files are available
  19.     for download on the BBS.   
  20.  
  21.  
  22. USE OF MKSFFBBS
  23. ---------------
  24.  
  25.          MKSFFBBS can be executed by typing MKSFFBBS at the DOS
  26.     prompt from the SPITFIRE HOME directory.  When first executed
  27.     the Buffalo Creek Software logo appears at the top center of
  28.     the screen displaying the program name.  Directly beneath the
  29.     logo a prompt appears which asks the user for the File Area in
  30.     which the SFFILES.BBS file is to be created.  You will then need
  31.     to respond by inputting the number of the File Area for which 
  32.     you are creating your SFFILES.BBS.  Simply pressing your < ENTER >
  33.     will cause MKSFFBBS to list the available File Areas. Once the 
  34.     File Area has been entered correctly, you will then be prompted
  35.     as to whether you wish the program, MKSFFBBS, to use the current
  36.     date or the existing file date.  Simply enter <T> if you prefer
  37.     to use today's date or <F> for the file date.  In the event an
  38.     SFFILES already exists in the selected File Area, you will then
  39.     be prompted with the below listed menu:
  40.      
  41.     SFFILES.BBS already exists.   
  42.     <A>... Append Present SFILES.BBS
  43.     <C>... Create New SFFILES.BBS
  44.     <Q>... Quit
  45.     Enter Command:
  46.         
  47.          If you respond with a <Q>... Quit MKSFFBBS is terminated and
  48.     you are returned to the DOS prompt.  
  49.     
  50.          If you select to <C>...Create New SFFILES.BBS, you will progress
  51.     through the same steps as if you were setting up the SFFILES.BBS for 
  52.     the first time and follow the same procedure described previously.
  53.     Please note, however, if you choose <C>... Create New SFFILES.BBS, all
  54.     the existing file descriptions will be overwritten!
  55.     
  56.          Most often, you will want to <A>ppend Present SFFILES.BBS file.  If
  57.     a SFFILES.BBS exists and you choose to append the existing file, then 
  58.     only the files from the specified directory which do not already exist 
  59.     in the file listing will be added to SFFILES.BBS.
  60.     
  61.          Finally, MKSFFBBS will prompt you with "Utilize FILE_ID.DIZ for
  62.     description when found in .ZIP files? [y/n]".  If you respond Yes to
  63.     this prompt, MKSFFBBS will search any .ZIP files for a FILE_ID.DIZ.
  64.     If a FILE_ID.DIZ is found, its contents will be used as the description
  65.     for the file to be added to the SFFILES.BBS.
  66.  
  67.          In the event you have selected to "Utilize FILE_ID.DIZ...", then
  68.     you will be prompted "Automatically add each file found? [y/n] ".
  69.     When you select this option, MKSFFBBS will not prompt "Do you wish to
  70.     add FILENAME.EXT? [y/n] " when the file is a .ZIP file which contains a
  71.     FILE_ID.DIZ.
  72.     
  73.          MKSFFBBS will individually display each file within the specified
  74.     directory (one at a time), along with the preferred date format you
  75.     selected earlier and the file size.  As each file is displayed, MKSFFBBS 
  76.     will prompt you by asking "Do you wish to add FILENAME.EXT? [y/n]".    
  77.      
  78.     
  79.  
  80.     FILENAME.EXT   123,456  08-15-92  Do you wish to add FILENAME.EXE? [y/n]?
  81.     
  82.     
  83.          If you respond with a "Y" and you have opted to use the FILE_ID.DIZ
  84.     and the .ZIP contains a FILE_ID.DIZ, the description contained within will
  85.     be used as the file description.  If you opted not to use the FILE_ID.DIZ,
  86.     or if the file is not a .ZIP archive or if the .ZIP does not contain a
  87.     FILE_ID.DIZ you are given the opportunity to enter the file description.
  88.     The filename, file size, and file date continues to be displayed and to 
  89.     the right of this display, a forty-five character input space is provided 
  90.     for you to supply a brief description of the file.  You will be provided 
  91.     the ability to enter the number of file description lines per your 
  92.     SPITFIRE configuration.
  93.     
  94.     
  95.                                     1---|---10---|---20---|---30---|---40---|
  96.     FILENAME.EXT   123,456  10-01-88     
  97.     
  98.     
  99.     Insert (In)Active   2 File Description Lines Allowed!  ESC to abort to DOS
  100.  
  101.          At the bottom of the screen, a message is displayed which notifies
  102.     you if the insert mode is active or inactive, the number of lines you have
  103.     configured for the file description and whether and also informs you that
  104.     you may abort the program and return to DOS by hitting the ESC key.
  105.           
  106.          If you respond with a "N" , then you will receive the below listed
  107.     prompt:
  108.  
  109.     FILENAME.EXT   123,456  08-15-92  Do you wish to erase FILENAME.EXE? [y/n]?
  110.  
  111.          In the event you select "Y", then MKSFFBBS will erase the file from
  112.     your drive.
  113.  
  114.          This will continue until all files in the directory have been
  115.     reviewed.
  116.  
  117.  
  118. CD-ROM SUPPORT
  119. --------------
  120.  
  121.          MKSFFBBS supports the use of CD-Rom drives.  In the event the File
  122.     Area you select is configured as a CD-Rom area, then MKSFFBBS will work
  123.     with the appropriate SFFILES in your DISPLAY directory while reading
  124.     the file information from the configured directory on the CD-Rom.
  125.  
  126.  
  127. EXITING MKSFFBBS
  128. ----------------
  129.  
  130.          After MKSFFBBS has displayed all the files in the directory and
  131.     you have entered your file descriptions, MKSFFBBS, if you appended
  132.     an existing SFFILES you will then prompted with the following:
  133.     "Would you like to check files against listing? [y/n]?"  This provides
  134.     an opportunity to check that all files listed in the SFFILES.BBS do,
  135.     in fact, exist in the directory.  If you respond with a "Y" and 
  136.     MKSFFBBS encounters a file listed in the SFFILES.BBS which does not
  137.     exist in the directory, you will be prompted with "Filename.ext not
  138.     found! Purge from list? [y/n]".  This is a quick way to make sure if
  139.     a file has been erased from the directory, that it has also been 
  140.     removed from the SFFILES.BBS list.  If you respond with a "N" the
  141.     file will remain listed in the SFFILES.BBS and if you respond with
  142.     a "Y" the file will be removed from the SFFILES.BBS listings.
  143.     
  144.          If you respond with a "N" to the "Would you like to check files
  145.     against listing?" or once you have completed the purge file option,
  146.     you are then prompted with "Do another? [y/n]".  This will allow you
  147.     to execute the MKSFFBBS on a new drive and/or directory.  If "Y" is 
  148.     selected you are once again prompted for the path and the program 
  149.     will continue as described above.  If you select "N" the program is 
  150.     terminated and you are returned to the DOS prompt.     
  151.  
  152.          
  153. CURSOR CONTROL
  154. ---------------
  155.  
  156.          As you move through each of the indiviual file listing for the
  157.     previously specified drive and subdirectory, you will may use any of
  158.     the following cursor movements while entering you descriptions:
  159.  
  160.  
  161.     Left arrow key  -- This will move the cursor left 1 character position.
  162.  
  163.     Right arrow key -- This will move the cursor right 1 character  
  164.                        position.
  165.  
  166.     Home key        -- This will move cursor to the beginning of the current 
  167.                        line.  
  168.              
  169.     End key         -- This will move cursor to the end of the current line.
  170.  
  171.  
  172.     Del key         -- This will delete the character in the current cursor
  173.                        posistion.
  174.       
  175.     Backspace key   -- This will delete the character to the left of the 
  176.                        current cursor position.
  177.                        
  178.     Escape key      -- Will abort the program and return you to the DOS  
  179.                        prompt. 
  180.  
  181.  
  182.       When entering your file descriptions, MKSFFBBS provides forty-five
  183.       character spaces for your remarks.  If you attempt to enter more
  184.       than the forty-five characters allowed the cursor will stop at the 
  185.       last space and a beep is issued to signal that no other input
  186.       can be entered.  
  187.                          
  188.  
  189. INSERT MODE
  190. ------------
  191.     
  192.        The insert key can be used to activate and deactivate the insert
  193.    mode.  The present mode is always displayed in the lower left hand 
  194.    portion of the screen.  It will display either as Insert Active or 
  195.    Insert Inactive.  
  196.  
  197.  
  198. FILE SHARING
  199. ------------
  200.          MKSFFBBS utilizes file sharing capabilities, therefore, there
  201.     should be no confliction using MKSFFBBS with the multi-node versions
  202.     of SPITFIRE.
  203.  
  204.  
  205. MKSFFBBS DISCLAIMER
  206. -------------------
  207.  
  208.          While Buffalo Creek Software reserves all rights to MKSFFBBS,
  209.     it is offered free for your use.  However, Mike Woltz and/or Buffalo
  210.     Creek Software shall not be held responsible for any damage incurred
  211.     by the user to hardware, software, or peripheral devices while running 
  212.     MKSFFBBS.  All responsibility lies with the user of the software.
  213.  
  214.           MKSFFBBS.DOC is contributed by Jacque Shipley and The Mother
  215.     Board BBS.  SPITFIRE and SPITFIRE utilities are available for download
  216.     on:
  217.     
  218.        Buffalo Creek's BBS                     The Mother Board BBS
  219.         Sysop - Mike Woltz                    Sysop - Jacque Shipley  
  220.     38400/19200/9600/2400/1200                     9600/2400/1200  
  221.          (515) 225-8496                            (515) 986-3445
  222.  
  223.  
  224. REVISIONS
  225. ---------
  226.  
  227.     Version 2.0 (June 1, 1992) - MKSFFBBS was revised to support multi-line
  228.     file descriptions.  MKSFFBBS was also revised to support CD-Rom drives.
  229.     When working with a File Area marked as a CD-Rom area MKSFFBBS creates
  230.     and maintains a SFFILES file in the configured DISPLAY directory whichs
  231.     pertains to the files in the File Area's download path.
  232.  
  233.     Version 2.1 (August 2, 1992) - MKSFFBBS was revised to provide the
  234.     opportunity to erase the file from the drive when such file is not added
  235.     to SFFILES.
  236.     
  237.     Version 2.2 (December 14, 1992) - MKSFFBBS was revised to include the
  238.     option which allows for the option of using FILE_ID.DIZ as the default
  239.     file description if it exists within the ZIP file.